Workbench Design/WB Collection.iso/datatypes/mrekodt/mreko.guide

Amigaguide Document | 1996-04-07 | 7KB | 179 lines

@database MREKO
@$VER: MREKO.guide 37.1 (11.4.95)
@(C) Michael Letowski
@author Michael Letowski
@node Main "MREKO 1.0"
@prev Main
@next Main
                                  @{b}@{u}MREKO 1.0@{uu}@{ub}
             MREKO package is Copyright
 1995 @{"Michael Letowski" link Author}.
                             All rights reserved.
      The author's native language is Polish, so please forgive bad spelling,
  grammar mistakes etc. Or better - correct them.
  @{"Copyright notice" link Copyright}
  @{"  Introduction  " link Introduction}
  @{"  Requirements  " link Requirements}
  @{"  Installation  " link Installation}
  @{"     History    " link History}
  @{"      To do     " link ToDo}
  @{"  reko.datatype " link REKO}
@endnode
@node Copyright "MREKO Copyright"
@prev Copyright
  @{b}@{u}Copyright@{uu}@{ub}
  MREKO package is Copyright
 1995 @{"Michael Letowski" link Author}.
  MREKO is freely distributable under the following conditions:
 no more than a reasonable fee is charged for copying/downloading;
 this distribution is not a part of other non-free distribution;
 the distribution is complete - it contains all the files (full list
      at the end of this chapter);
 no file in the distribution is changed.
      Distribution without meeting conditions specified above requires
  written permission from me.
      The @{"DataType" link DataTypes} from the package works, but no guarantee is given nor
  implied. In no case will I be liable for any results of using supplied
  @{"DataType" link DataTypes}.
      The source code is provided only for informational purposes and is
  also under copyright. It is based on source for @{i}bmp.datatype@{ui} by David
  N. Junod.
      This documentation is based on @{i}CatEdit.guide@{ui}, which is Copyright
  1993 Rafael D'Halleweyn.
      @{"Klondike AGA" link Klondike} is Copyright REKO Productions.
  List of all files in the distribution:
    @{i}Install MREKO.info
    Install MREKO
    MREKO.guide.info
    MREKO.guide
    Libs (dir)
      DataTypes (dir)
        reko.datatype
    Devs.info
    Devs (dir)
      DataTypes.info
      DataTypes (dir)
        REKO Cardset.info
        REKO Cardset
    Src (dir)
      classbase.c
      dispatch.c@{ui}
@endnode
@node Introduction "Introduction to MREKO"
  @{b}@{u}Introduction@{uu}@{ub}
      @{"reko.datatype" link REKO} is a @{"DataTypes" link DataTypes} subclass for loading and viewing
  @{"Klondike AGA" link Klondike} cardsets. Once installed it will let all @{"DataTypes" link DataTypes} aware
  programs to recognize and load @{"Klondike AGA" link Klondike} cardsets.
      There exists another @{i}REKO@{ui} @{"DataType" link DataTypes}, written by Athur Pijpers.
  However, it is rather buggy (crashes and hangs my A1200 all the time).
  Therefore I wrote (from scratch) my own one. It is smaller (2440 vs. 2832
  bytes), better (e.g. uses @{i}BestModeID@{ui} to determine most suitable display
  mode), faster (about 30%) and more stable (everything is checked to ensure
  no crashes can occur).
@endnode
@node Requirements "Requirements for MREKO"
  @{b}@{u}Requirements@{uu}@{ub}
      @{"reko.datatype" link REKO} requires AmigaDOS 3.0 or higher (@{i}datatypes.library@{ui}
  V39+). AGA chipset is recomended, since all known @{"Klondike AGA" link Klondike} cardsets
  use HAM8 mode. Without AGA chipset you will get very distorted pictures.
@endnode
@node Installation "Installation of MREKO"
  @{b}@{u}Installation@{uu}@{ub}
      Use supplied @{i}Installer@{ui} script to copy necessary files. Activate
  class by double-clicking on @{i}DEVS:DataTypes/REKO Cardset@{ui} icon or use
  @{i}AddDataTypes REFRESH@{ui} from Shell.
@endnode
@node History "MREKO History"
  @{b}@{u}History@{uu}@{ub}
      Version 1.0 (11.4.95) - initial release.
@endnode
@node ToDo "To do in MREKO"
@next ToDo
  @{b}@{u}To do@{uu}@{ub}
      @{"reko.datatype" link REKO} seem to be complete, but perhaps you have some
  suggestions?
@endnode
@node REKO "reko.datatype"
@prev REKO
@next REKO
@{fg highlight}NAME@{fg text}
      @{b}reko.datatype@{ub} - @{"DataTypes link DataTypes} subclass for loading and displaying @{"Klondike AGA" link Klondike}
  cardsets.
@{fg highlight}FUNCTION@{fg text}
      @{b}reko.datatype@{ub} will load @{"Klondike AGA" link Klondike} version I or II cardsets (it
  will probably load future versions cardsets too.) It is designed to deal
  with arbitrary cards sizes.
@{fg highlight}METHODS@{fg text}
      @{b}OM_NEW@{ub} - create new instance of object.
@{fg highlight}BUGS@{fg text}
      Users without AGA chipsets will see very distorted pictures.
@{fg highlight}NOTES@{fg text}
      Cardsets are always displayed in HAM8 mode (I don't know any cardsets
  requiring other modes.) This could be avoided, if all cardsets had
  properly encoded display mode. Unfortunately, they don't...
@endnode
@node DataTypes "DataTypes Information"
@prev DataTypes
@next DataTypes
  @{b}@{u}DataTypes@{uu}@{ub}
      @{i}DataTypes@{ui} is an AmigaDOS subsystem (introduced in AmigaDOS 3.0) for
  dealing with different types of files found on different machines (PC's,
  Macs and Amigas). @{i}DataTypes@{ui} can be used for recognizing types of files
  and interpreting informations in this files. An example of the latter is
  @{i}MultiView@{ui}, which can show many types of data.
      @{i}DataTypes@{ui} divide all files into the following main categories:

 @{i}syst@{ui} (System) - system files;

 @{i}text@{ui} (Text) - textual files;

 @{i}docu@{ui} (Document) - documents (spreadsheet data, text with
        pictures etc.);

 @{i}soun@{ui} (Sound) - sound samples;

 @{i}inst@{ui} (Instrument) - musical instruments;

 @{i}musi@{ui} (Music) - songs;

 @{i}pict@{ui} (Picture) - graphics;

 @{i}anim@{ui} (Animation) - animations;

 @{i}movi@{ui} (Movie) - animation with sound.
      Each category is further divided into subclasses. Each subclass
  interprets one type of file, converting it to some universal format.
  @{"reko.datatype" link REKO} is an example of such subclass.
@endnode
@node Klondike "Klondike AGA"
@prev Klondike
@next Klondike
  @{b}@{u}Klondike@{uu}@{ub}
      @{i}Klondike AGA@{ui} is a great solitaire game. It has great graphics
  and sound. The game requires AGA chipset.
@endnode
@node Author "About the Author"
@prev Author
@next Author
  @{b}@{u}About the Author@{uu}@{ub}
      @{i}MREKO@{ui} package was written by @{b}Michael Letowski@{ub}, who is a Software
  Engineering student at Technical University of Wroclaw and has A1200.
      If you have something to say me (questions, remarks, suggestions,
  wishes, bug reports) please contact me (I like receiving mail!):
    by E-Mail (preferred way):
      @{b}[e-mail]@{ub}
      @{b}[e-mail]@{ub}
    by normal mail:
      @{b}Michal Letowski
      Przyjazni 51/17
      53-030 Wroclaw
      POLAND@{ub}
      You can get my other packages:
   @{" MCommands " link MCommands.guide/main} - 7 useful AmigaDOS CLI commands
      (@{i}Aminet://util/cli/MCommands-1.2.lha@{ui});
   @{"    MCEd   " link MCEd.guide/main} - 8 great ARexx scripts for CygnusEd users
      (@{i}Aminet://text/edit/MCEd-1.2.lha@{ui});
   @{"ClipHandler" link ClipHandler.guide/main} - easily exchange data between AmigaDOS and applications
      (@{i}Aminet://util/misc/ClipHandl-1.0.lha@{ui}).
@endnode